<!DOCTYPE html>
<html>
<head>
	<meta http-equiv="Content-Type" content="text/html; charset=utf-8" />
	<meta name="generator" content="ApiGen 2.7.0" />

	<title>Class Swift_Mime_Headers_MailboxHeader | nort</title>

	<script type="text/javascript" src="resources/combined.js?1481722677"></script>
	<script type="text/javascript" src="elementlist.js?1094816827"></script>
	<link rel="stylesheet" type="text/css" media="all" href="resources/style.css?1567499433" />

</head>

<body>
<div id="left">
	<div id="menu">
		<a href="index.html" title="Overview"><span>Overview</span></a>


		<div id="groups">
			<h3>Packages</h3>
			<ul>
				<li><a href="package-App.html">App<span></span></a>
						<ul>
				<li><a href="package-App.Saas.html">Saas</a>
						</li>
				<li><a href="package-App.saas.html">saas</a>
						</li>
				<li><a href="package-App.SaaS.html">SaaS<span></span></a>
						<ul>
				<li><a href="package-App.saas.Logic.html">Logic</a>
						</li>
				<li><a href="package-App.SaaS.SaaS.html">SaaS</a>
						</li>
				<li><a href="package-App.Saas.Tables.html">Tables</a>
						</li>
				<li><a href="package-App.Saas.Vo.html">Vo</a>
						</li>
							</ul></li></ul></li>
				<li><a href="package-aqua.html">aqua<span></span></a>
						<ul>
				<li><a href="package-aqua.tools.html">tools<span></span></a>
						<ul>
				<li><a href="package-aqua.tools.Monitor.html">Monitor</a>
						</li>
							</ul></li></ul></li>
				<li><a href="package-flashservices.html">flashservices<span></span></a>
						<ul>
				<li><a href="package-flashservices.adapters.html">adapters</a>
						</li>
				<li><a href="package-flashservices.debug.html">debug</a>
						</li>
				<li><a href="package-flashservices.exception.html">exception</a>
						</li>
				<li><a href="package-flashservices.filters.html">filters</a>
						</li>
				<li><a href="package-flashservices.io.html">io</a>
						</li>
				<li><a href="package-flashservices.sql.html">sql</a>
						</li>
				<li><a href="package-flashservices.util.html">util</a>
						</li>
							</ul></li>
				<li><a href="package-Mekayotl.html">Mekayotl<span></span></a>
						<ul>
				<li><a href="package-Mekayotl.core.html">core</a>
						</li>
				<li><a href="package-Mekayotl.database.html">database<span></span></a>
						<ul>
				<li><a href="package-Mekayotl.database.dal.html">dal</a>
						</li>
				<li><a href="package-Mekayotl.database.mysql.html">mysql</a>
						</li>
				<li><a href="package-Mekayotl.database.sqlite.html">sqlite</a>
						</li>
							</ul></li>
				<li><a href="package-Mekayotl.tools.html">tools<span></span></a>
						<ul>
				<li><a href="package-Mekayotl.tools.render.html">render<span></span></a>
						<ul>
				<li><a href="package-Mekayotl.tools.render.html.html">html</a>
						</li>
							</ul></li>
				<li><a href="package-Mekayotl.tools.renders.html">renders</a>
						</li>
							</ul></li></ul></li>
				<li><a href="package-None.html">None</a>
						</li>
				<li><a href="package-PHP.html">PHP</a>
						</li>
				<li><a href="package-PHPMailer.html">PHPMailer</a>
						</li>
				<li><a href="package-Services.html">Services<span></span></a>
						<ul>
				<li><a href="package-Services.JSON.html">JSON</a>
						</li>
							</ul></li>
				<li class="active"><a href="package-Swift.html">Swift<span></span></a>
						<ul>
				<li><a href="package-Swift.ByteStream.html">ByteStream</a>
						</li>
				<li><a href="package-Swift.CharacterStream.html">CharacterStream</a>
						</li>
				<li><a href="package-Swift.Encoder.html">Encoder</a>
						</li>
				<li><a href="package-Swift.Events.html">Events</a>
						</li>
				<li><a href="package-Swift.KeyCache.html">KeyCache</a>
						</li>
				<li><a href="package-Swift.Mailer.html">Mailer</a>
						</li>
				<li class="active"><a href="package-Swift.Mime.html">Mime</a>
						</li>
				<li><a href="package-Swift.Plugins.html">Plugins</a>
						</li>
				<li><a href="package-Swift.Transport.html">Transport</a>
						</li>
							</ul></li>
			</ul>
		</div>

		<hr />


		<div id="elements">
			<h3>Classes</h3>
			<ul>
				<li><a href="class-Swift_Attachment.html">Swift_Attachment</a></li>
				<li><a href="class-Swift_EmbeddedFile.html">Swift_EmbeddedFile</a></li>
				<li><a href="class-Swift_Image.html">Swift_Image</a></li>
				<li><a href="class-Swift_Message.html">Swift_Message</a></li>
				<li><a href="class-Swift_Mime_Attachment.html">Swift_Mime_Attachment</a></li>
				<li><a href="class-Swift_Mime_ContentEncoder_Base64ContentEncoder.html">Swift_Mime_ContentEncoder_Base64ContentEncoder</a></li>
				<li><a href="class-Swift_Mime_ContentEncoder_PlainContentEncoder.html">Swift_Mime_ContentEncoder_PlainContentEncoder</a></li>
				<li><a href="class-Swift_Mime_ContentEncoder_QpContentEncoder.html">Swift_Mime_ContentEncoder_QpContentEncoder</a></li>
				<li><a href="class-Swift_Mime_EmbeddedFile.html">Swift_Mime_EmbeddedFile</a></li>
				<li><a href="class-Swift_Mime_Grammar.html">Swift_Mime_Grammar</a></li>
				<li><a href="class-Swift_Mime_HeaderEncoder_Base64HeaderEncoder.html">Swift_Mime_HeaderEncoder_Base64HeaderEncoder</a></li>
				<li><a href="class-Swift_Mime_HeaderEncoder_QpHeaderEncoder.html">Swift_Mime_HeaderEncoder_QpHeaderEncoder</a></li>
				<li><a href="class-Swift_Mime_Headers_AbstractHeader.html">Swift_Mime_Headers_AbstractHeader</a></li>
				<li><a href="class-Swift_Mime_Headers_DateHeader.html">Swift_Mime_Headers_DateHeader</a></li>
				<li><a href="class-Swift_Mime_Headers_IdentificationHeader.html">Swift_Mime_Headers_IdentificationHeader</a></li>
				<li class="active"><a href="class-Swift_Mime_Headers_MailboxHeader.html">Swift_Mime_Headers_MailboxHeader</a></li>
				<li><a href="class-Swift_Mime_Headers_ParameterizedHeader.html">Swift_Mime_Headers_ParameterizedHeader</a></li>
				<li><a href="class-Swift_Mime_Headers_PathHeader.html">Swift_Mime_Headers_PathHeader</a></li>
				<li><a href="class-Swift_Mime_Headers_UnstructuredHeader.html">Swift_Mime_Headers_UnstructuredHeader</a></li>
				<li><a href="class-Swift_Mime_MimePart.html">Swift_Mime_MimePart</a></li>
				<li><a href="class-Swift_Mime_SimpleHeaderFactory.html">Swift_Mime_SimpleHeaderFactory</a></li>
				<li><a href="class-Swift_Mime_SimpleHeaderSet.html">Swift_Mime_SimpleHeaderSet</a></li>
				<li><a href="class-Swift_Mime_SimpleMessage.html">Swift_Mime_SimpleMessage</a></li>
				<li><a href="class-Swift_Mime_SimpleMimeEntity.html">Swift_Mime_SimpleMimeEntity</a></li>
				<li><a href="class-Swift_MimePart.html">Swift_MimePart</a></li>
			</ul>

			<h3>Interfaces</h3>
			<ul>
				<li><a href="class-Swift_Mime_CharsetObserver.html">Swift_Mime_CharsetObserver</a></li>
				<li><a href="class-Swift_Mime_ContentEncoder.html">Swift_Mime_ContentEncoder</a></li>
				<li><a href="class-Swift_Mime_EncodingObserver.html">Swift_Mime_EncodingObserver</a></li>
				<li><a href="class-Swift_Mime_Header.html">Swift_Mime_Header</a></li>
				<li><a href="class-Swift_Mime_HeaderEncoder.html">Swift_Mime_HeaderEncoder</a></li>
				<li><a href="class-Swift_Mime_HeaderFactory.html">Swift_Mime_HeaderFactory</a></li>
				<li><a href="class-Swift_Mime_HeaderSet.html">Swift_Mime_HeaderSet</a></li>
				<li><a href="class-Swift_Mime_Message.html">Swift_Mime_Message</a></li>
				<li><a href="class-Swift_Mime_MimeEntity.html">Swift_Mime_MimeEntity</a></li>
				<li><a href="class-Swift_Mime_ParameterizedHeader.html">Swift_Mime_ParameterizedHeader</a></li>
			</ul>




		</div>
	</div>
</div>

<div id="splitter"></div>

<div id="right">
<div id="rightInner">
	<form id="search">
		<input type="hidden" name="cx" value="" />
		<input type="hidden" name="ie" value="UTF-8" />
		<input type="text" name="q" class="text" />
		<input type="submit" value="Search" />
	</form>

	<div id="navigation">
		<ul>
			<li>
				<a href="index.html" title="Overview"><span>Overview</span></a>
			</li>
			<li>
				<a href="package-Swift.Mime.html" title="Summary of Swift\Mime"><span>Package</span></a>
			</li>
			<li class="active">
<span>Class</span>			</li>
		</ul>
		<ul>
			<li>
				<a href="tree.html" title="Tree view of classes, interfaces, traits and exceptions"><span>Tree</span></a>
			</li>
		</ul>
		<ul>
		</ul>
	</div>

<div id="content" class="class">
	<h1>Class Swift_Mime_Headers_MailboxHeader</h1>


	<div class="description">
	
<p>A Mailbox Address MIME Header for something like From or Sender.</p>

	</div>

	<dl class="tree">
		<dd style="padding-left:0px">
			<a href="class-Swift_Mime_Headers_AbstractHeader.html"><span>Swift_Mime_Headers_AbstractHeader</span></a>
			
			 implements 
				<a href="class-Swift_Mime_Header.html"><span>Swift_Mime_Header</span></a>
			
			
		</dd>
		<dd style="padding-left:30px">
			<img src="resources/inherit.png" alt="Extended by" />
<b><span>Swift_Mime_Headers_MailboxHeader</span></b>			
			
			
		</dd>
	</dl>








	<div class="info">
		
		
		
		<b>Package:</b> <a href="package-Swift.html">Swift</a>\<a href="package-Swift.Mime.html">Mime</a><br />

				<b>Author:</b>
				Chris Corbyn<br />
		<b>Located at</b> <a href="source-class-Swift_Mime_Headers_MailboxHeader.html#11" title="Go to source code">lib/php/externals/swift/classes/Swift/Mime/Headers/MailboxHeader.php</a><br />
	</div>


	<table class="summary" id="methods">
	<caption>Methods summary</caption>
	<tr data-order="__construct" id="___construct">

		<td class="attributes"><code>
			 public 
			
			
			</code>
		</td>

		<td class="name"><div>
		<a class="anchor" href="#___construct">#</a>
		<code><a href="source-class-Swift_Mime_Headers_MailboxHeader.html#29" title="Go to source code">__construct</a>( <span>string <var>$name</var></span>, <span><code><a href="class-Swift_Mime_HeaderEncoder.html">Swift_Mime_HeaderEncoder</a></code> <var>$encoder</var></span>, <span><code><a href="class-Swift_Mime_Grammar.html">Swift_Mime_Grammar</a></code> <var>$grammar</var></span> )</code>

		<div class="description short">
			
<p>Creates a new MailboxHeader with $name.</p>

		</div>

		<div class="description detailed hidden">
			
<p>Creates a new MailboxHeader with $name.</p>



				<h4>Parameters</h4>
				<div class="list"><dl>
					<dt><var>$name</var></dt>
					<dd><code>string</code><br> of Header</dd>
					<dt><var>$encoder</var></dt>
					<dd><code><code><a href="class-Swift_Mime_HeaderEncoder.html">Swift_Mime_HeaderEncoder</a></code></code></dd>
					<dt><var>$grammar</var></dt>
					<dd><code><code><a href="class-Swift_Mime_Grammar.html">Swift_Mime_Grammar</a></code></code></dd>
				</dl></div>




				<h4>Overrides</h4>
				<div class="list"><code><a href="class-Swift_Mime_Headers_AbstractHeader.html#_">Swift_Mime_Headers_AbstractHeader::__construct</a></code></div>

		</div>
		</div></td>
	</tr>
	<tr data-order="getFieldType" id="_getFieldType">

		<td class="attributes"><code>
			 public 
			integer
			
			</code>
		</td>

		<td class="name"><div>
		<a class="anchor" href="#_getFieldType">#</a>
		<code><a href="source-class-Swift_Mime_Headers_MailboxHeader.html#44" title="Go to source code">getFieldType</a>( )</code>

		<div class="description short">
			
<p>Get the type of Header that this instance represents.</p>

		</div>

		<div class="description detailed hidden">
			
<p>Get the type of Header that this instance represents.</p>




				<h4>Returns</h4>
				<div class="list">
					<code>integer</code><br />
				</div>


				<h4>See</h4>
				<div class="list">
						<code><code><a href="class-Swift_Mime_Header.html#TYPE_TEXT">Swift_Mime_Header::<b>TYPE_TEXT</b></a></code></code>, <code><code><a href="class-Swift_Mime_Header.html#TYPE_PARAMETERIZED">Swift_Mime_Header::<b>TYPE_PARAMETERIZED</b></a></code></code>, <code><code><a href="class-Swift_Mime_Header.html#TYPE_MAILBOX">Swift_Mime_Header::<b>TYPE_MAILBOX</b></a></code></code><br />
						<code><code><a href="class-Swift_Mime_Header.html#TYPE_DATE">Swift_Mime_Header::<b>TYPE_DATE</b></a></code></code>, <code><code><a href="class-Swift_Mime_Header.html#TYPE_ID">Swift_Mime_Header::<b>TYPE_ID</b></a></code></code>, <code><code><a href="class-Swift_Mime_Header.html#TYPE_PATH">Swift_Mime_Header::<b>TYPE_PATH</b></a></code></code><br />
				</div>


				<h4>Implementation of</h4>
				<div class="list"><code><a href="class-Swift_Mime_Header.html#_">Swift_Mime_Header::getFieldType</a></code></div>
		</div>
		</div></td>
	</tr>
	<tr data-order="setFieldBodyModel" id="_setFieldBodyModel">

		<td class="attributes"><code>
			 public 
			
			
			</code>
		</td>

		<td class="name"><div>
		<a class="anchor" href="#_setFieldBodyModel">#</a>
		<code><a href="source-class-Swift_Mime_Headers_MailboxHeader.html#56" title="Go to source code">setFieldBodyModel</a>( <span>mixed <var>$model</var></span> )</code>

		<div class="description short">
			
<p>Set the model for the field body. This method takes a string, or an array of
addresses.</p>

		</div>

		<div class="description detailed hidden">
			
<p>Set the model for the field body. This method takes a string, or an array of
addresses.</p>



				<h4>Parameters</h4>
				<div class="list"><dl>
					<dt><var>$model</var></dt>
					<dd><code>mixed</code></dd>
				</dl></div>


				<h4>Throws</h4>
				<div class="list">
					<code><code><a href="class-Swift_RfcComplianceException.html">Swift_RfcComplianceException</a></code></code><br />
				</div>



				<h4>Implementation of</h4>
				<div class="list"><code><a href="class-Swift_Mime_Header.html#_">Swift_Mime_Header::setFieldBodyModel</a></code></div>
		</div>
		</div></td>
	</tr>
	<tr data-order="getFieldBodyModel" id="_getFieldBodyModel">

		<td class="attributes"><code>
			 public 
			array
			
			</code>
		</td>

		<td class="name"><div>
		<a class="anchor" href="#_getFieldBodyModel">#</a>
		<code><a href="source-class-Swift_Mime_Headers_MailboxHeader.html#68" title="Go to source code">getFieldBodyModel</a>( )</code>

		<div class="description short">
			
<p>Get the model for the field body. This method returns an associative array
like <code><a href="class-Swift_Mime_Headers_MailboxHeader.html#_">Swift_Mime_Headers_MailboxHeader::getNameAddresses()</a></code></p>

		</div>

		<div class="description detailed hidden">
			
<p>Get the model for the field body. This method returns an associative array
like <code><a href="class-Swift_Mime_Headers_MailboxHeader.html#_">Swift_Mime_Headers_MailboxHeader::getNameAddresses()</a></code></p>




				<h4>Returns</h4>
				<div class="list">
					<code>array</code><br />
				</div>

				<h4>Throws</h4>
				<div class="list">
					<code><code><a href="class-Swift_RfcComplianceException.html">Swift_RfcComplianceException</a></code></code><br />
				</div>



				<h4>Implementation of</h4>
				<div class="list"><code><a href="class-Swift_Mime_Header.html#_">Swift_Mime_Header::getFieldBodyModel</a></code></div>
		</div>
		</div></td>
	</tr>
	<tr data-order="setNameAddresses" id="_setNameAddresses">

		<td class="attributes"><code>
			 public 
			
			
			</code>
		</td>

		<td class="name"><div>
		<a class="anchor" href="#_setNameAddresses">#</a>
		<code><a href="source-class-Swift_Mime_Headers_MailboxHeader.html#80" title="Go to source code">setNameAddresses</a>( <span>string|string[] <var>$mailboxes</var></span> )</code>

		<div class="description short">
			
<p>Set a list of mailboxes to be shown in this Header. The mailboxes can be a
simple array of addresses, or an array of key=&gt;value pairs where (email =&gt;
personalName). Example:</p>

<pre>
<span class="xlang">&lt;?php</span>
<span
class="php-comment">//Sets two mailboxes in the Header, one with a personal name</span>
<span
class="php-var">$header</span>-&gt;setNameAddresses(<span
class="php-keyword1">array</span>(
 <span
class="php-quote">'chris@swiftmailer.org'</span> =&gt; <span
class="php-quote">'Chris Corbyn'</span>,
 <span
class="php-quote">'mark@swiftmailer.org'</span> <span
class="php-comment">//No associated personal name</span>
 ));
<span
class="xlang">?&gt;</span>
</pre>

		</div>

		<div class="description detailed hidden">
			
<p>Set a list of mailboxes to be shown in this Header. The mailboxes can be a
simple array of addresses, or an array of key=&gt;value pairs where (email =&gt;
personalName). Example:</p>

<pre>
<span class="xlang">&lt;?php</span>
<span
class="php-comment">//Sets two mailboxes in the Header, one with a personal name</span>
<span
class="php-var">$header</span>-&gt;setNameAddresses(<span
class="php-keyword1">array</span>(
 <span
class="php-quote">'chris@swiftmailer.org'</span> =&gt; <span
class="php-quote">'Chris Corbyn'</span>,
 <span
class="php-quote">'mark@swiftmailer.org'</span> <span
class="php-comment">//No associated personal name</span>
 ));
<span
class="xlang">?&gt;</span>
</pre>



				<h4>Parameters</h4>
				<div class="list"><dl>
					<dt><var>$mailboxes</var></dt>
					<dd><code>string|string[]</code></dd>
				</dl></div>


				<h4>Throws</h4>
				<div class="list">
					<code><code><a href="class-Swift_RfcComplianceException.html">Swift_RfcComplianceException</a></code></code><br />
				</div>

				<h4>See</h4>
				<div class="list">
						<code><code><a href="class-Swift_Mime_Headers_MailboxHeader.html#_">Swift_Mime_Headers_MailboxHeader::__construct()</a></code></code><br />
						<code><code><a href="class-Swift_Mime_Headers_MailboxHeader.html#_">Swift_Mime_Headers_MailboxHeader::setAddresses()</a></code></code><br />
						setValue()<br />
				</div>


		</div>
		</div></td>
	</tr>
	<tr data-order="getNameAddressStrings" id="_getNameAddressStrings">

		<td class="attributes"><code>
			 public 
			string[]
			
			</code>
		</td>

		<td class="name"><div>
		<a class="anchor" href="#_getNameAddressStrings">#</a>
		<code><a href="source-class-Swift_Mime_Headers_MailboxHeader.html#107" title="Go to source code">getNameAddressStrings</a>( )</code>

		<div class="description short">
			
<p>Get the full mailbox list of this Header as an array of valid RFC 2822
strings. Example:</p>

<pre>
<span class="xlang">&lt;?php</span>
<span
class="php-var">$header</span> = <span
class="php-keyword1">new</span> Swift_Mime_Headers_MailboxHeader(<span
class="php-quote">'From'</span>,
 <span class="php-keyword1">array</span>(<span
class="php-quote">'chris@swiftmailer.org'</span> =&gt; <span
class="php-quote">'Chris Corbyn'</span>,
 <span
class="php-quote">'mark@swiftmailer.org'</span> =&gt; <span
class="php-quote">'Mark Corbyn'</span>)
 );
<span
class="php-keyword2">print_r</span>(<span
class="php-var">$header</span>-&gt;getNameAddressStrings());
<span
class="php-comment">// array (</span>
<span
class="php-comment">// 0 =&gt; Chris Corbyn &lt;chris@swiftmailer.org&gt;,</span>
<span
class="php-comment">// 1 =&gt; Mark Corbyn &lt;mark@swiftmailer.org&gt;</span>
<span
class="php-comment">// )</span>
<span class="xlang">?&gt;</span>
</pre>

		</div>

		<div class="description detailed hidden">
			
<p>Get the full mailbox list of this Header as an array of valid RFC 2822
strings. Example:</p>

<pre>
<span class="xlang">&lt;?php</span>
<span
class="php-var">$header</span> = <span
class="php-keyword1">new</span> Swift_Mime_Headers_MailboxHeader(<span
class="php-quote">'From'</span>,
 <span class="php-keyword1">array</span>(<span
class="php-quote">'chris@swiftmailer.org'</span> =&gt; <span
class="php-quote">'Chris Corbyn'</span>,
 <span
class="php-quote">'mark@swiftmailer.org'</span> =&gt; <span
class="php-quote">'Mark Corbyn'</span>)
 );
<span
class="php-keyword2">print_r</span>(<span
class="php-var">$header</span>-&gt;getNameAddressStrings());
<span
class="php-comment">// array (</span>
<span
class="php-comment">// 0 =&gt; Chris Corbyn &lt;chris@swiftmailer.org&gt;,</span>
<span
class="php-comment">// 1 =&gt; Mark Corbyn &lt;mark@swiftmailer.org&gt;</span>
<span
class="php-comment">// )</span>
<span class="xlang">?&gt;</span>
</pre>




				<h4>Returns</h4>
				<div class="list">
					<code>string[]</code><br />
				</div>

				<h4>Throws</h4>
				<div class="list">
					<code><code><a href="class-Swift_RfcComplianceException.html">Swift_RfcComplianceException</a></code></code><br />
				</div>

				<h4>See</h4>
				<div class="list">
						<code><code><a href="class-Swift_Mime_Headers_MailboxHeader.html#_">Swift_Mime_Headers_MailboxHeader::getNameAddresses()</a></code></code><br />
						<code><code><a href="class-Swift_Mime_Headers_AbstractHeader.html#_">Swift_Mime_Headers_AbstractHeader::toString()</a></code></code><br />
				</div>


		</div>
		</div></td>
	</tr>
	<tr data-order="getNameAddresses" id="_getNameAddresses">

		<td class="attributes"><code>
			 public 
			string[]
			
			</code>
		</td>

		<td class="name"><div>
		<a class="anchor" href="#_getNameAddresses">#</a>
		<code><a href="source-class-Swift_Mime_Headers_MailboxHeader.html#134" title="Go to source code">getNameAddresses</a>( )</code>

		<div class="description short">
			
<p>Get all mailboxes in this Header as key=&gt;value pairs. The key is the
address and the value is the name (or NULL if none set). Example:</p>

<pre>
<span class="xlang">&lt;?php</span>
<span
class="php-var">$header</span> = <span
class="php-keyword1">new</span> Swift_Mime_Headers_MailboxHeader(<span
class="php-quote">'From'</span>,
 <span class="php-keyword1">array</span>(<span
class="php-quote">'chris@swiftmailer.org'</span> =&gt; <span
class="php-quote">'Chris Corbyn'</span>,
 <span
class="php-quote">'mark@swiftmailer.org'</span> =&gt; <span
class="php-quote">'Mark Corbyn'</span>)
 );
<span
class="php-keyword2">print_r</span>(<span
class="php-var">$header</span>-&gt;getNameAddresses());
<span
class="php-comment">// array (</span>
<span
class="php-comment">// chris@swiftmailer.org =&gt; Chris Corbyn,</span>
<span
class="php-comment">// mark@swiftmailer.org =&gt; Mark Corbyn</span>
<span
class="php-comment">// )</span>
<span class="xlang">?&gt;</span>
</pre>

		</div>

		<div class="description detailed hidden">
			
<p>Get all mailboxes in this Header as key=&gt;value pairs. The key is the
address and the value is the name (or NULL if none set). Example:</p>

<pre>
<span class="xlang">&lt;?php</span>
<span
class="php-var">$header</span> = <span
class="php-keyword1">new</span> Swift_Mime_Headers_MailboxHeader(<span
class="php-quote">'From'</span>,
 <span class="php-keyword1">array</span>(<span
class="php-quote">'chris@swiftmailer.org'</span> =&gt; <span
class="php-quote">'Chris Corbyn'</span>,
 <span
class="php-quote">'mark@swiftmailer.org'</span> =&gt; <span
class="php-quote">'Mark Corbyn'</span>)
 );
<span
class="php-keyword2">print_r</span>(<span
class="php-var">$header</span>-&gt;getNameAddresses());
<span
class="php-comment">// array (</span>
<span
class="php-comment">// chris@swiftmailer.org =&gt; Chris Corbyn,</span>
<span
class="php-comment">// mark@swiftmailer.org =&gt; Mark Corbyn</span>
<span
class="php-comment">// )</span>
<span class="xlang">?&gt;</span>
</pre>




				<h4>Returns</h4>
				<div class="list">
					<code>string[]</code><br />
				</div>


				<h4>See</h4>
				<div class="list">
						<code><code><a href="class-Swift_Mime_Headers_MailboxHeader.html#_">Swift_Mime_Headers_MailboxHeader::getAddresses()</a></code></code><br />
						<code><code><a href="class-Swift_Mime_Headers_MailboxHeader.html#_">Swift_Mime_Headers_MailboxHeader::getNameAddressStrings()</a></code></code><br />
				</div>


		</div>
		</div></td>
	</tr>
	<tr data-order="setAddresses" id="_setAddresses">

		<td class="attributes"><code>
			 public 
			
			
			</code>
		</td>

		<td class="name"><div>
		<a class="anchor" href="#_setAddresses">#</a>
		<code><a href="source-class-Swift_Mime_Headers_MailboxHeader.html#161" title="Go to source code">setAddresses</a>( <span>string[] <var>$addresses</var></span> )</code>

		<div class="description short">
			
<p>Makes this Header represent a list of plain email addresses with no names.
Example:</p>

<pre>
<span class="xlang">&lt;?php</span>
<span
class="php-comment">//Sets three email addresses as the Header data</span>
<span
class="php-var">$header</span>-&gt;setAddresses(
 <span
class="php-keyword1">array</span>(<span
class="php-quote">'one@domain.tld'</span>, <span
class="php-quote">'two@domain.tld'</span>, <span
class="php-quote">'three@domain.tld'</span>)
 );
<span
class="xlang">?&gt;</span>
</pre>

		</div>

		<div class="description detailed hidden">
			
<p>Makes this Header represent a list of plain email addresses with no names.
Example:</p>

<pre>
<span class="xlang">&lt;?php</span>
<span
class="php-comment">//Sets three email addresses as the Header data</span>
<span
class="php-var">$header</span>-&gt;setAddresses(
 <span
class="php-keyword1">array</span>(<span
class="php-quote">'one@domain.tld'</span>, <span
class="php-quote">'two@domain.tld'</span>, <span
class="php-quote">'three@domain.tld'</span>)
 );
<span
class="xlang">?&gt;</span>
</pre>



				<h4>Parameters</h4>
				<div class="list"><dl>
					<dt><var>$addresses</var></dt>
					<dd><code>string[]</code></dd>
				</dl></div>


				<h4>Throws</h4>
				<div class="list">
					<code><code><a href="class-Swift_RfcComplianceException.html">Swift_RfcComplianceException</a></code></code><br />
				</div>

				<h4>See</h4>
				<div class="list">
						<code><code><a href="class-Swift_Mime_Headers_MailboxHeader.html#_">Swift_Mime_Headers_MailboxHeader::setNameAddresses()</a></code></code><br />
						setValue()<br />
				</div>


		</div>
		</div></td>
	</tr>
	<tr data-order="getAddresses" id="_getAddresses">

		<td class="attributes"><code>
			 public 
			string[]
			
			</code>
		</td>

		<td class="name"><div>
		<a class="anchor" href="#_getAddresses">#</a>
		<code><a href="source-class-Swift_Mime_Headers_MailboxHeader.html#183" title="Go to source code">getAddresses</a>( )</code>

		<div class="description short">
			
<p>Get all email addresses in this Header.</p>

		</div>

		<div class="description detailed hidden">
			
<p>Get all email addresses in this Header.</p>




				<h4>Returns</h4>
				<div class="list">
					<code>string[]</code><br />
				</div>


				<h4>See</h4>
				<div class="list">
						<code><code><a href="class-Swift_Mime_Headers_MailboxHeader.html#_">Swift_Mime_Headers_MailboxHeader::getNameAddresses()</a></code></code><br />
				</div>


		</div>
		</div></td>
	</tr>
	<tr data-order="removeAddresses" id="_removeAddresses">

		<td class="attributes"><code>
			 public 
			
			
			</code>
		</td>

		<td class="name"><div>
		<a class="anchor" href="#_removeAddresses">#</a>
		<code><a href="source-class-Swift_Mime_Headers_MailboxHeader.html#194" title="Go to source code">removeAddresses</a>( <span>string|string[] <var>$addresses</var></span> )</code>

		<div class="description short">
			
<p>Remove one or more addresses from this Header.</p>

		</div>

		<div class="description detailed hidden">
			
<p>Remove one or more addresses from this Header.</p>



				<h4>Parameters</h4>
				<div class="list"><dl>
					<dt><var>$addresses</var></dt>
					<dd><code>string|string[]</code></dd>
				</dl></div>





		</div>
		</div></td>
	</tr>
	<tr data-order="getFieldBody" id="_getFieldBody">

		<td class="attributes"><code>
			 public 
			string
			
			</code>
		</td>

		<td class="name"><div>
		<a class="anchor" href="#_getFieldBody">#</a>
		<code><a href="source-class-Swift_Mime_Headers_MailboxHeader.html#207" title="Go to source code">getFieldBody</a>( )</code>

		<div class="description short">
			
<p>Get the string value of the body in this Header. This is not necessarily RFC
2822 compliant since folding white space will not be added at this stage (see
<code><a href="class-Swift_Mime_Headers_AbstractHeader.html#_">Swift_Mime_Headers_AbstractHeader::toString()</a></code> for that).</p>

		</div>

		<div class="description detailed hidden">
			
<p>Get the string value of the body in this Header. This is not necessarily RFC
2822 compliant since folding white space will not be added at this stage (see
<code><a href="class-Swift_Mime_Headers_AbstractHeader.html#_">Swift_Mime_Headers_AbstractHeader::toString()</a></code> for that).</p>




				<h4>Returns</h4>
				<div class="list">
					<code>string</code><br />
				</div>

				<h4>Throws</h4>
				<div class="list">
					<code><code><a href="class-Swift_RfcComplianceException.html">Swift_RfcComplianceException</a></code></code><br />
				</div>

				<h4>See</h4>
				<div class="list">
						<code><code><a href="class-Swift_Mime_Headers_AbstractHeader.html#_">Swift_Mime_Headers_AbstractHeader::toString()</a></code></code><br />
				</div>


				<h4>Implementation of</h4>
				<div class="list"><code><a href="class-Swift_Mime_Header.html#_">Swift_Mime_Header::getFieldBody</a></code></div>
		</div>
		</div></td>
	</tr>
	<tr data-order="normalizeMailboxes" id="_normalizeMailboxes">

		<td class="attributes"><code>
			 protected 
			string[]
			
			</code>
		</td>

		<td class="name"><div>
		<a class="anchor" href="#_normalizeMailboxes">#</a>
		<code><a href="source-class-Swift_Mime_Headers_MailboxHeader.html#228" title="Go to source code">normalizeMailboxes</a>( <span>array <var>$mailboxes</var></span> )</code>

		<div class="description short">
			
<p>Normalizes a user-input list of mailboxes into consistent key=&gt;value
pairs.</p>

		</div>

		<div class="description detailed hidden">
			
<p>Normalizes a user-input list of mailboxes into consistent key=&gt;value
pairs.</p>



				<h4>Parameters</h4>
				<div class="list"><dl>
					<dt><var>$mailboxes</var></dt>
					<dd><code>string[]</code></dd>
				</dl></div>

				<h4>Returns</h4>
				<div class="list">
					<code>string[]</code><br />
				</div>




		</div>
		</div></td>
	</tr>
	<tr data-order="createDisplayNameString" id="_createDisplayNameString">

		<td class="attributes"><code>
			 protected 
			string
			
			</code>
		</td>

		<td class="name"><div>
		<a class="anchor" href="#_createDisplayNameString">#</a>
		<code><a href="source-class-Swift_Mime_Headers_MailboxHeader.html#255" title="Go to source code">createDisplayNameString</a>( <span>string <var>$displayName</var></span>, <span>boolean <var>$shorten</var> = <span class="php-keyword1">FALSE</span></span> )</code>

		<div class="description short">
			
<p>Produces a compliant, formatted display-name based on the string given.</p>

		</div>

		<div class="description detailed hidden">
			
<p>Produces a compliant, formatted display-name based on the string given.</p>



				<h4>Parameters</h4>
				<div class="list"><dl>
					<dt><var>$displayName</var></dt>
					<dd><code>string</code><br> as displayed</dd>
					<dt><var>$shorten</var></dt>
					<dd><code>boolean</code><br> the first line to make remove for header name</dd>
				</dl></div>

				<h4>Returns</h4>
				<div class="list">
					<code>string</code><br />
				</div>




		</div>
		</div></td>
	</tr>
	<tr data-order="createMailboxListString" id="_createMailboxListString">

		<td class="attributes"><code>
			 protected 
			string
			
			</code>
		</td>

		<td class="name"><div>
		<a class="anchor" href="#_createMailboxListString">#</a>
		<code><a href="source-class-Swift_Mime_Headers_MailboxHeader.html#269" title="Go to source code">createMailboxListString</a>( <span>array <var>$mailboxes</var></span> )</code>

		<div class="description short">
			
<p>Creates a string form of all the mailboxes in the passed array.</p>

		</div>

		<div class="description detailed hidden">
			
<p>Creates a string form of all the mailboxes in the passed array.</p>



				<h4>Parameters</h4>
				<div class="list"><dl>
					<dt><var>$mailboxes</var></dt>
					<dd><code>string[]</code></dd>
				</dl></div>

				<h4>Returns</h4>
				<div class="list">
					<code>string</code><br />
				</div>

				<h4>Throws</h4>
				<div class="list">
					<code><code><a href="class-Swift_RfcComplianceException.html">Swift_RfcComplianceException</a></code></code><br />
				</div>



		</div>
		</div></td>
	</tr>
	</table>

	<table class="summary inherited">
	<caption>Methods inherited from <a href="class-Swift_Mime_Headers_AbstractHeader.html#methods">Swift_Mime_Headers_AbstractHeader</a></caption>
	<tr>
		<td><code>
			<a href="class-Swift_Mime_Headers_AbstractHeader.html#_">__toString()</a>, 
			<a href="class-Swift_Mime_Headers_AbstractHeader.html#_">clearCachedValueIf()</a>, 
			<a href="class-Swift_Mime_Headers_AbstractHeader.html#_">createPhrase()</a>, 
			<a href="class-Swift_Mime_Headers_AbstractHeader.html#_">encodeWords()</a>, 
			<a href="class-Swift_Mime_Headers_AbstractHeader.html#_">generateTokenLines()</a>, 
			<a href="class-Swift_Mime_Headers_AbstractHeader.html#_">getCachedValue()</a>, 
			<a href="class-Swift_Mime_Headers_AbstractHeader.html#_">getCharset()</a>, 
			<a href="class-Swift_Mime_Headers_AbstractHeader.html#_">getEncodableWordTokens()</a>, 
			<a href="class-Swift_Mime_Headers_AbstractHeader.html#_">getEncoder()</a>, 
			<a href="class-Swift_Mime_Headers_AbstractHeader.html#_">getFieldName()</a>, 
			<a href="class-Swift_Mime_Headers_AbstractHeader.html#_">getGrammar()</a>, 
			<a href="class-Swift_Mime_Headers_AbstractHeader.html#_">getLanguage()</a>, 
			<a href="class-Swift_Mime_Headers_AbstractHeader.html#_">getMaxLineLength()</a>, 
			<a href="class-Swift_Mime_Headers_AbstractHeader.html#_">getTokenAsEncodedWord()</a>, 
			<a href="class-Swift_Mime_Headers_AbstractHeader.html#_">setCachedValue()</a>, 
			<a href="class-Swift_Mime_Headers_AbstractHeader.html#_">setCharset()</a>, 
			<a href="class-Swift_Mime_Headers_AbstractHeader.html#_">setEncoder()</a>, 
			<a href="class-Swift_Mime_Headers_AbstractHeader.html#_">setFieldName()</a>, 
			<a href="class-Swift_Mime_Headers_AbstractHeader.html#_">setGrammar()</a>, 
			<a href="class-Swift_Mime_Headers_AbstractHeader.html#_">setLanguage()</a>, 
			<a href="class-Swift_Mime_Headers_AbstractHeader.html#_">setMaxLineLength()</a>, 
			<a href="class-Swift_Mime_Headers_AbstractHeader.html#_">toString()</a>, 
			<a href="class-Swift_Mime_Headers_AbstractHeader.html#_">toTokens()</a>, 
			<a href="class-Swift_Mime_Headers_AbstractHeader.html#_">tokenNeedsEncoding()</a>
		</code></td>
	</tr>
	</table>




	<table class="summary inherited">
	<caption>Constants inherited from <a href="class-Swift_Mime_Header.html#constants">Swift_Mime_Header</a></caption>
	<tr>
		<td><code>
			<a href="class-Swift_Mime_Header.html#TYPE_DATE"><b>TYPE_DATE</b></a>, 
			<a href="class-Swift_Mime_Header.html#TYPE_ID"><b>TYPE_ID</b></a>, 
			<a href="class-Swift_Mime_Header.html#TYPE_MAILBOX"><b>TYPE_MAILBOX</b></a>, 
			<a href="class-Swift_Mime_Header.html#TYPE_PARAMETERIZED"><b>TYPE_PARAMETERIZED</b></a>, 
			<a href="class-Swift_Mime_Header.html#TYPE_PATH"><b>TYPE_PATH</b></a>, 
			<a href="class-Swift_Mime_Header.html#TYPE_TEXT"><b>TYPE_TEXT</b></a>
		</code></td>
	</tr>
	</table>





</div>

	<div id="footer">
		nort API documentation generated by <a href="http://apigen.org">ApiGen 2.7.0</a>
	</div>
</div>
</div>
</body>
</html>
